package org.shs.company.form;

import org.apache.struts.action.ActionForm;

/**
 * Captures all screen parameters for the company listing screen
 * <br/>
 * <br/><b>Created:</b>&nbsp;&nbsp; Dec 8, 2008 11:46:39 PM
 *
 * @author Gunjan
 *
 */
public class CompanyForm extends ActionForm
{

   /**
    * Serialization version of this class.
    */
   private static final long serialVersionUID = 1L;
   
   // The company name search string.
   private String companySrch = null;
   
   // The company ID to view details of.
   private String companyId = null;

   // The user ID of the current logged-in user.
   private String userId = null;
   
   // The company's description
   private String companyDesc = null;
   
   // The IDs of all the selected companies
   private String[] chkCompanyId = null;
   
   // The company name.
   private String companyName;
   
   // First line of the company address.
   private String address1;
   
   // Second line of the company address.
   private String address2;
   
   // Third line of the company address.
   private String address3;
   
   // City of the company.
   private String city;
   
   // State of the company.
   private String state;
   
   // Postal code of the company.
   private String postalCode;
   
   // Fixed-line phone number of the company.
   private String companyPhone;
   
   // Name of the contact person.
   private String contactName;
   
   // Fixed-line phone number of the contact person.
   private String contactPhone;
   
   // Mobile phone number of the contact person.
   private String contactMobile;
   
   // E-mail address of the contact person.
   private String contactEMail;
   
   // Monthly operational fees to be charged from the company.
   private String monthlyFees;

   // Estimated monthly labour costs incurred on the company.
   private String labourCost;
   
   // Comments regarding the company.
   private String comments;

   // Flag specifying if the company account is active.
   private String active;
   
   // Indicates whether deactivated companies should also be searched
   private String srchInactive = "0";

   /**
    * Returns the company name search string.
    * @return The company name search string.
    */
   public String getCompanySrch()
   {
      return companySrch;
   }

   /**
    * Sets the company name search string.
    * @param companySrch The company name search string.
    */
   public void setCompanySrch(String companySrch)
   {
      this.companySrch = companySrch;
   }

   /**
    * Returns the company ID to view details of.
    * @return The company ID to view details of.
    */
   public String getCompanyId()
   {
      return companyId;
   }

   /**
    * Sets the company ID to view details of.
    * @param companyId The company ID to view details of.
    */
   public void setCompanyId(String companyId)
   {
      this.companyId = companyId;
   }

   /**
    * Returns the user ID of the current logged-in user.
    * @return The user ID of the current logged-in user.
    */
   public String getUserId()
   {
      return userId;
   }

   /**
    * Sets the user ID of the current logged-in user.
    * @param userId The user ID of the current logged-in user.
    */
   public void setUserId(String userId)
   {
      this.userId = userId;
   }

   /**
    * Returns the IDs of all the selected companies
    * @return the IDs of all the selected companies
    */
   public String[] getChkCompanyId()
   {
      return chkCompanyId;
   }

   /**
    * Sets the IDs of all the selected companies
    * @param the IDs of all the selected companies
    */
   public void setChkCompanyId(String[] chkCompanyId)
   {
      this.chkCompanyId = chkCompanyId;
   }

   /**
    * Returns the company's description
    * @return the company's description
    */
   public String getCompanyDesc()
   {
      return companyDesc;
   }

   /**
    * Sets the company's description
    * @param the company's description
    */
   public void setCompanyDesc(String companyDesc)
   {
      this.companyDesc = companyDesc;
   }
   
   /**
    * Returns the company name.
    * @return The company name.
    */
   public String getCompanyName()
   {
      return companyName;
   }

   /**
    * Sets the company name. 
    * @param companyName The company name.
    */
   public void setCompanyName(String companyName)
   {
      this.companyName = companyName;
   }

   /**
    * Returns first line of the company address.
    * @return First line of the company address.
    */
   public String getAddress1()
   {
      return address1;
   }

   /**
    * Sets first line of the company address.
    * @param address1 First line of the company address.
    */
   public void setAddress1(String address1)
   {
      this.address1 = address1;
   }

   /**
    * Returns second line of the company address.
    * @return Second line of the company address.
    */
   public String getAddress2()
   {
      return address2;
   }

   /**
    * Sets Second line of the company address.
    * @param address2 Second line of the company address.
    */
   public void setAddress2(String address2)
   {
      this.address2 = address2;
   }

   /**
    * Returns third line of the company address.
    * @return Third line of the company address.
    */
   public String getAddress3()
   {
      return address3;
   }

   /**
    * Sets third line of the company address.
    * @param address3 Third line of the company address.
    */
   public void setAddress3(String address3)
   {
      this.address3 = address3;
   }

   /**
    * Returns the city of the company.
    * @return City of the company.
    */
   public String getCity()
   {
      return city;
   }

   /**
    * Sets the city of the company.
    * @param city City of the company.
    */
   public void setCity(String city)
   {
      this.city = city;
   }

   /**
    * Returns the state of the company.
    * @return State of the company.
    */
   public String getState()
   {
      return state;
   }

   /**
    * Sets the sstate of the company.
    * @param state State of the company.
    */
   public void setState(String state)
   {
      this.state = state;
   }

   /**
    * Returns the postal code of the company.
    * @return Postal code of the company.
    */
   public String getPostalCode()
   {
      return postalCode;
   }

   /**
    * Sets the postal code of the company.
    * @param postalCode Postal code of the company.
    */
   public void setPostalCode(String postalCode)
   {
      this.postalCode = postalCode;
   }

   /**
    * Returns the fixed-line phone number of the company.
    * @return Fixed-line phone number of the company.
    */
   public String getCompanyPhone()
   {
      return companyPhone;
   }

   /**
    * Sets the fixed-line phone number of the company.
    * @param companyPhone Fixed-line phone number of the company.
    */
   public void setCompanyPhone(String companyPhone)
   {
      this.companyPhone = companyPhone;
   }

   /**
    * Returns the name of the contact person.
    * @return Name of the contact person.
    */
   public String getContactName()
   {
      return contactName;
   }

   /**
    * Sets the name of the contact person.
    * @param contactName Name of the contact person.
    */
   public void setContactName(String contactName)
   {
      this.contactName = contactName;
   }

   /**
    * Returns the fixed-line phone number of the contact person.
    * @return Fixed-line phone number of the contact person.
    */
   public String getContactPhone()
   {
      return contactPhone;
   }

   /**
    * Sets the fixed-line phone number of the contact person.
    * @param contactPhone Fixed-line phone number of the contact person.
    */
   public void setContactPhone(String contactPhone)
   {
      this.contactPhone = contactPhone;
   }

   /**
    * Returns the mobile phone number of the contact person.
    * @return Mobile phone number of the contact person.
    */
   public String getContactMobile()
   {
      return contactMobile;
   }

   /**
    * Sets the mobile phone number of the contact person.
    * @param contactMobile Mobile phone number of the contact person.
    */
   public void setContactMobile(String contactMobile)
   {
      this.contactMobile = contactMobile;
   }

   /**
    * Returns the e-mail address of the contact person.
    * @return E-mail address of the contact person.
    */
   public String getContactEMail()
   {
      return contactEMail;
   }

   /**
    * Sets the e-mail address of the contact person.
    * @param contactEMail E-mail address of the contact person.
    */
   public void setContactEMail(String contactEMail)
   {
      this.contactEMail = contactEMail;
   }

   /**
    * Returns the monthly operational fees to be charged from the company.
    * @return Monthly operational fees to be charged from the company.
    */
   public String getMonthlyFees()
   {
      return monthlyFees;
   }

   /**
    * Sets the monthly fees to be charged from the company.
    * @param monthlyFees Monthly fees to be charged from the company.
    */
   public void setMonthlyFees(String monthlyFees)
   {
      this.monthlyFees = monthlyFees;
   }

   /**
    * Returns the estimated monthly labour costs incurred on the company.
    * @return Estimated monthly labour costs incurred on the company.
    */
   public String getLabourCost()
   {
      return labourCost;
   }

   /**
    * Sets the estimated monthly labour costs incurred on the company.
    * @param labourCost Estimated monthly labour costs incurred on the company.
    */
   public void setLabourCost(String labourCost)
   {
      this.labourCost = labourCost;
   }

   /**
    * Returns the comments regarding the company.
    * @return Comments regarding the company.
    */
   public String getComments()
   {
      return comments;
   }

   /**
    * Sets the comments regarding the company.
    * @param comments Comments regarding the company.
    */
   public void setComments(String comments)
   {
      this.comments = comments;
   }

   /**
    * Returns the flag specifying if the company accounts are active.
    * @return Flag specifying if the company accounts are active.
    */
   public String getActive()
   {
      return active;
   }

   /**
    * Sets the flag specifying if the company accounts are active.
    * @param active Flag specifying if the company accounts are active.
    */
   public void setActive(String active)
   {
      this.active = active;
   }

   /**
    * Search deactivated companies?
    * @return 
    */
   public String getSrchInactive()
   {
      return srchInactive;
   }

   /**
    * Search deactivated companies?
    * @param 
    */
   public void setSrchInactive(String srchInactive)
   {
      this.srchInactive = srchInactive;
   }

}